FMPXMLRESULT

Schema/Grammar

 

Document Type Definition


 <!DOCTYPE FMPXMLRESULT [

<!ELEMENT FMPXMLRESULT (ERRORCODE, PRODUCT, DATABASE, METADATA, RESULTSET)>
<!ATTLIST FMPXMLRESULT
xmlns CDATA #REQUIRED>

<!ELEMENT ERRORCODE (#PCDATA)>

<!ELEMENT PRODUCT EMPTY>

<!ATTLIST PRODUCT
NAME CDATA #REQUIRED

VERSION CDATA #REQUIRED

BUILD CDATA #REQUIRED>

<!ELEMENT DATABASE EMPTY>

<!ATTLIST DATABASE
NAME CDATA #REQUIRED

RECORDS CDATA #REQUIRED

DATEFORMAT CDATA #REQUIRED

TIMEFORMAT CDATA #REQUIRED

LAYOUT CDATA #REQUIRED>

<!ELEMENT METADATA (FIELD)*>

<!ELEMENT FIELD EMPTY>
<!ATTLIST FIELD
NAME CDATA #REQUIRED

TYPE (TEXT | NUMBER | DATE | TIME | TIMESTAMP | CONTAINER) #REQUIRED

EMPTYOK (YES| NO) #REQUIRED

MAXREPEAT CDATA #REQUIRED>

<!ELEMENT RESULTSET (ROW)*>

<!ATTLIST RESULTSET
FOUND CDATA #REQUIRED>

<!ELEMENT ROW (COL)*>

<!ATTLIST ROW
RECORDID CDATA #REQUIRED

MODID CDATA #REQUIRED>

<!ELEMENT COL (DATA)*>

<!ELEMENT DATA (#PCDATA)>

]>

 

Element descriptions


ERRORCODE

Error code for the query.


PRODUCT

Information about the version of FileMaker that generated the XML.

Attribute:

NAME

Product Name


VERSION

Product version number.


BUILD

Product build number.


DATABASE

Information about the database specified in the query.

Attribute:

NAME

Database name.


RECORDS

Total number of records in database.


DATEFORMAT

The format that dates are stored in the database.

Field

Full Form

Short Form

Year

yyyy (4 digits)

yy (2 digits)

Month

MM (2 digits)

M (1 or 2 digits)

Day of month

dd (2 digits)

d (1 or 2 digits)


TIMEFORMAT

The format that times are stored in the database.

Field

Full Form

Short Form

Hour (1-12)

hh (2 digits)

h (1 or 2 digits)

Hour (1-24)

kk (2 digits)

k (1 or 2 digits)

Minute

mm

 

Second

ss

 

AM/PM

a

 


LAYOUT

The name of the layout that was used to generate the result set.


METADATA

This element contains one or more FIELD elements (see below).


FIELD

Each field element contains information about one of the fields/columns in the result set.

 Attributes:

 NAME

 The name of the field as specified in the "Define Fields Dialog" in FileMaker

TYPE

The field type (see DTD for valid values)

EMPTYOK

Can the field be empty.

MAXREPEAT

The number of allowed repeating values.


RESULTSET

Contains all of the rows returned in response to a query (see ROW below).

Attributes: 

FOUND

Total number of records found by the query.


ROW

Contains the field/column data for one row in the result set (see COL below).

Attributes:

 RECORDID

The record id for the row.

MODID

The modification id for the row.


COL

The data for one field/column in a row. COL elements are specified in the same order as FIELD elements within the METADATA element. The COL element can contain multiple DATA elements for repeating and portal fields.


DATA 

Each DATA element represents one of the values in the field/column.

Note: The content of picture fields will be in the form of a relative URL used for retrieving the image.

 

Copyright © 1999 - 2004 FileMaker, Inc. All rights reserved.